Skip to content

docs(backend): link lockUser() JSDoc to the current Protect rules page - #9976

Merged
manovotny merged 1 commit into
mainfrom
manovotny/lock-user-protect-rules-link
Sep 29, 2026
Merged

manovotny merged 1 commit into
mainfrom
manovotny/lock-user-protect-rules-link

Conversation

@manovotny

Copy link
Copy Markdown
Contributor

Description

Updates the Dashboard link in the lockUser() JSDoc from https://dashboard.clerk.com/~/protect/rules/system to https://dashboard.clerk.com/~/protect/rules.

/~/protect/rules/system stopped being a page and became a redirect to /~/protect/rules in clerk/dashboard#10303, which reached production on 2026-09-29. https://dashboard.clerk.com/links.json now lists /~/protect/rules under links and /~/protect/rules/system under redirects.

clerk/clerk's lint:dashboard-links check fails links that only resolve through a Dashboard redirect, and the generated TypeDoc output there (clerk-docs/clerk-typedoc/backend/user-api/methods/lock-user.mdx and clerk-docs/clerk-typedoc/backend/user-api/user-api.mdx) carries this link. Lint in clerk/clerk fails on the old link for every PR until this ships and the TypeDoc sync runs.

Checklist

  • pnpm test runs as expected.
  • pnpm build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

🤖 Generated with Claude Code

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@vercel

vercel Bot commented Sep 29, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
clerk-js-sandbox Ready Ready Preview Sep 29, 2026 4:19pm UTC
swingset Ready Ready Preview Sep 29, 2026 4:19pm UTC

Request Review

@changeset-bot

changeset-bot Bot commented Sep 29, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 7e961dc

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 11 packages
Name Type
@clerk/backend Patch
@clerk/astro Patch
@clerk/express Patch
@clerk/fastify Patch
@clerk/hono Patch
@clerk/nextjs Patch
@clerk/nuxt Patch
@clerk/react-router Patch
@clerk/tanstack-react-start Patch
@clerk/testing Patch
@clerk/swingset Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@coderabbitai

coderabbitai Bot commented Sep 29, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: ASSERTIVE

Plan: Team

Run ID: e5801f3d-d22b-4bd1-b8f6-a0d30f529a2f

📥 Commits

Reviewing files that changed from the base of the PR and between f98988b and 7e961dc.

📒 Files selected for processing (2)
  • .changeset/lock-user-protect-rules-link.md
  • packages/backend/src/api/endpoints/UserApi.ts
🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

Included review availability: This review used your included allowance. 7 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 8 reviews per hour.


📝 Walkthrough

Walkthrough

The lockUser() documentation now links to the Dashboard’s Protect rules settings page instead of the prior system-specific URL. A patch changeset records the documentation update for @clerk/backend. Runtime behavior is unchanged.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Suggested reviewers: tmilewski

Merge Risk: ⚪ Minimal · up to 7e961

No concrete merge-blocking risk remains in this documentation-link update and its changeset.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: updating the lockUser() JSDoc link to the current Protect rules page.
Description check ✅ Passed The description directly explains the link update, the redirect change, and the related dashboard-link lint issue. It is relevant to the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown
Contributor

API Changes Report

Generated by Break Check on 2026-09-29T16:22:28.972Z

Summary

Metric Count
Packages analyzed 19
Packages with changes 0
🔴 Breaking changes 0
🟡 Non-breaking changes 0
🟢 Additions 0

No API Changes Detected

All packages have stable APIs with no detected changes.


Report generated by Break Check

Last ran on 7e961dc.

@pkg-pr-new

pkg-pr-new Bot commented Sep 29, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

npm i https://pkg.pr.new/@clerk/astro@9976

@clerk/backend

npm i https://pkg.pr.new/@clerk/backend@9976

@clerk/chrome-extension

npm i https://pkg.pr.new/@clerk/chrome-extension@9976

@clerk/clerk-js

npm i https://pkg.pr.new/@clerk/clerk-js@9976

@clerk/electron

npm i https://pkg.pr.new/@clerk/electron@9976

@clerk/electron-passkeys

npm i https://pkg.pr.new/@clerk/electron-passkeys@9976

@clerk/eslint-plugin

npm i https://pkg.pr.new/@clerk/eslint-plugin@9976

@clerk/expo

npm i https://pkg.pr.new/@clerk/expo@9976

@clerk/expo-google-signin

npm i https://pkg.pr.new/@clerk/expo-google-signin@9976

@clerk/expo-passkeys

npm i https://pkg.pr.new/@clerk/expo-passkeys@9976

@clerk/express

npm i https://pkg.pr.new/@clerk/express@9976

@clerk/fastify

npm i https://pkg.pr.new/@clerk/fastify@9976

@clerk/hono

npm i https://pkg.pr.new/@clerk/hono@9976

@clerk/localizations

npm i https://pkg.pr.new/@clerk/localizations@9976

@clerk/mosaic

npm i https://pkg.pr.new/@clerk/mosaic@9976

@clerk/nextjs

npm i https://pkg.pr.new/@clerk/nextjs@9976

@clerk/nuxt

npm i https://pkg.pr.new/@clerk/nuxt@9976

@clerk/react

npm i https://pkg.pr.new/@clerk/react@9976

@clerk/react-router

npm i https://pkg.pr.new/@clerk/react-router@9976

@clerk/shared

npm i https://pkg.pr.new/@clerk/shared@9976

@clerk/tanstack-react-start

npm i https://pkg.pr.new/@clerk/tanstack-react-start@9976

@clerk/testing

npm i https://pkg.pr.new/@clerk/testing@9976

@clerk/ui

npm i https://pkg.pr.new/@clerk/ui@9976

@clerk/upgrade

npm i https://pkg.pr.new/@clerk/upgrade@9976

@clerk/vue

npm i https://pkg.pr.new/@clerk/vue@9976

commit: 7e961dc

@manovotny
manovotny merged commit e34a5cc into main Sep 29, 2026
56 of 64 checks passed
@manovotny
manovotny deleted the manovotny/lock-user-protect-rules-link branch September 29, 2026 16:31

This branch was successfully deployed

2 active deployments
Preview – swingset — 7e961dcf Deployed Sep 29, 2026 by vercel[bot]
Preview – clerk-js-sandbox — 7e961dcf Deployed Sep 29, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants